Describe Rails subscriber implementation #2179
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The agent uses a non-traditional way to subscribe to Rails events. Instead of passing a block to ActiveSupport::Notifications.subscribe, the agent defines a #start and #finish method, which Rails responds to. This is due to a threading issue discovered on initial instrumentation. Issue: rails/rails#12069 Rails code: https://github.com/rails/rails/blob/ed5af004598fa7645fec2210453cca00f4b59168/activesupport/lib/active_support/notifications/fanout.rb#L320
hannahramadan
requested review from
fallwith,
kaylareopelle and
tannalynn
as code owners
kaylareopelle
previously approved these changes
Aug 30, 2023
There was a problem hiding this comment.
I think this addition is great as-is. The only change I'd recommend is to add a link to the Rails issue in the comment. It could look like "See: rails/rails#12069"
SimpleCov Report
|
kaylareopelle
approved these changes
Sep 5, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a code comment for future readers. The agent uses a non-traditional way to subscribe to Rails events. Instead of passing a block to
ActiveSupport::Notifications.subscribe, the agent defines a#startand#finishmethod, which Rails responds to. This is due to a threading issue discovered on initial instrumentation.